Command Line Parameters

Top  Previous  Next

Backup4all can be started with various command line parameters to execute different actions on backup jobs or groups, load backup jobs, run the application minimized to tray or run the backup configured for the One Touch Backup button. The parameters can be used to create shortcuts which start actions automatically or load directly a specified backup job. Also if your One Touch Backup button device is not detected by Backup4all (Backup4all is not natively compatible with the device), you could use the command line parameters to create a command that can be associated to the One Touch Backup button of your device.

 

Syntax

        Backup4all [[{/l|/f|/d|/i|/r|/e|/t|/c}] name | /g group | /otb] [/s]

 

Formatting legend

        Italic - Information that must be supplied by the user

        Bold - Elements that the user must type exactly as shown

        / - Switches are preceded by slash

        [] - Elements between square brackets are optional

        | - Vertical line separates possible choices

        {} - Items between braces are a set of choices from which the user must choose only one

 

Valid parameter is an ".ini" file (with its full path), a ".bkc" file (with its full path) or the name of the backup job. The ".ini" or ".bkc" file must exist in the specified path, the backup job must be defined in Backup4all or otherwise the backup will not run.

 

Switches that apply to this parameter (case insensitive, preceded by "/" or "-"):

·/l - load the specified backup job, .ini file or .bkc file
·/f - force the execution of a full backup
·/d - force the execution of a differential backup
·/i - force the execution of an incremental backup
·/r - execute the backup with its defined type (this is the default behavior when the backup name is specified without switches)
·/e - erase the disc (FDD/CD/DVD) before backup
·/t - starts the test operation for the named job. Supports also an additional parameter [/TN 1,2,5..20|*|#] - if no TN is set then it will test all backup jobs same as using *; if # is used it will test only the last backup job (# can be used in the same time with other numbers too).
·/c - deletes the .bkc file and all zip files associated with the named backup job

 

If the backup job to be executed has the backup type set to Mirror, then a mirror backup will be performed and the "/f", "/d", "/i" switches will be ignored even if they are set.

 

You can also have as parameter an existing backup group. This group must be defined in Backup4all, otherwise the backup will not run. Switch to apply to this parameter (case insensitive, preceded by "/" or "-"):

·/g - execute the jobs in the backup group with their defined types (the switch is mandatory if you want to execute a backup group)

 

When called without parameters, but with the /otb switch, Backup4all executes the backup job or backup group specified in the OTB settings (from the Options->One Touch Backup page of Backup4all).

 

There is an extra switch, "/s". You can use it to start Backup4all minimized to the system tray. This switch can be used in combination with the other parameters and switches to run backup jobs or backup groups minimized to the system tray, or to load a specific backup job, while the application is still in minimized state.

 

Examples:

To force a full backup on the backup job associated with the IE Favorites.bkc located in the "E:\Backup Destination" folder, use:

        Backup4all /f "E:\Backup Destination\IE Favorites.bkc"

 

To start Backup4all minimized and force an incremental backup on the My Documents backup job, use:

        Backup4all /i "My Documents" /s

 

To execute all backup jobs from the Samples group, use:

        Backup4all /g Samples

 

To execute the backup job or backup group associated with One Touch Backup, use:

        Backup4all /otb

 

To execute a test for all backup numbers of the My Pictures backup job

        Backup4all /t "My Pictures" /tn *

 

To execute a test for first two and last backup number of the My Pictures backup job

        Backup4all /t "My Pictures" /tn 1,2,#

 

Backup job definitions (".ini" files) are saved separately for each Windows user. These files can be found in the "Application Data\Softland\Backup4all 3\IniFiles" folder of your user profile (if it's not changed in the Tools->Options->File locations window). Backup catalogs (".bkc" files) are saved locally and in the backup destination together with the backup archive. When a backup job is executed for the first time, a .bkc file is created. There is only one .bkc file for each backup job.

 

When valid parameters are provided with valid switches Backup4all will execute the commands.